3 * Global functions used everywhere.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 use MediaWiki\Logger\LoggerFactory
;
28 use MediaWiki\ProcOpenError
;
29 use MediaWiki\Session\SessionManager
;
30 use MediaWiki\MediaWikiServices
;
31 use MediaWiki\Shell\Shell
;
32 use Wikimedia\ScopedCallback
;
33 use Wikimedia\Rdbms\DBReplicationWaitError
;
35 // Hide compatibility functions from Doxygen
38 * Compatibility functions
40 * We support PHP 5.5.9 and up.
41 * Re-implementations of newer functions or functions in non-standard
42 * PHP extensions may be included here.
45 // hash_equals function only exists in PHP >= 5.6.0
46 // https://secure.php.net/hash_equals
47 if ( !function_exists( 'hash_equals' ) ) {
49 * Check whether a user-provided string is equal to a fixed-length secret string
50 * without revealing bytes of the secret string through timing differences.
52 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
53 * function in C) is to compare corresponding bytes and stop at the first difference,
54 * which would take longer for a partial match than for a complete mismatch. This
55 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
56 * and the other may come from an attacker. Statistical analysis of timing measurements
57 * over many requests may allow the attacker to guess the string's bytes one at a time
58 * (and check his guesses) even if the timing differences are extremely small.
60 * When making such a security-sensitive comparison, it is essential that the sequence
61 * in which instructions are executed and memory locations are accessed not depend on
62 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
63 * the inevitable leakage of the string's length. That is generally known anyway as
64 * a chararacteristic of the hash function used to compute the secret value.
66 * Longer explanation: http://www.emerose.com/timing-attacks-explained
69 * @param string $known_string Fixed-length secret string to compare against
70 * @param string $user_string User-provided string
71 * @return bool True if the strings are the same, false otherwise
73 function hash_equals( $known_string, $user_string ) {
74 // Strict type checking as in PHP's native implementation
75 if ( !is_string( $known_string ) ) {
76 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
77 gettype( $known_string ) . ' given', E_USER_WARNING
);
82 if ( !is_string( $user_string ) ) {
83 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
84 gettype( $user_string ) . ' given', E_USER_WARNING
);
89 $known_string_len = strlen( $known_string );
90 if ( $known_string_len !== strlen( $user_string ) ) {
95 for ( $i = 0; $i < $known_string_len; $i++
) {
96 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
99 return ( $result === 0 );
107 * This queues an extension to be loaded through
108 * the ExtensionRegistry system.
110 * @param string $ext Name of the extension to load
111 * @param string|null $path Absolute path of where to find the extension.json file
114 function wfLoadExtension( $ext, $path = null ) {
116 global $wgExtensionDirectory;
117 $path = "$wgExtensionDirectory/$ext/extension.json";
119 ExtensionRegistry
::getInstance()->queue( $path );
123 * Load multiple extensions at once
125 * Same as wfLoadExtension, but more efficient if you
126 * are loading multiple extensions.
128 * If you want to specify custom paths, you should interact with
129 * ExtensionRegistry directly.
131 * @see wfLoadExtension
132 * @param string[] $exts Array of extension names to load
135 function wfLoadExtensions( array $exts ) {
136 global $wgExtensionDirectory;
137 $registry = ExtensionRegistry
::getInstance();
138 foreach ( $exts as $ext ) {
139 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
146 * @see wfLoadExtension
147 * @param string $skin Name of the extension to load
148 * @param string|null $path Absolute path of where to find the skin.json file
151 function wfLoadSkin( $skin, $path = null ) {
153 global $wgStyleDirectory;
154 $path = "$wgStyleDirectory/$skin/skin.json";
156 ExtensionRegistry
::getInstance()->queue( $path );
160 * Load multiple skins at once
162 * @see wfLoadExtensions
163 * @param string[] $skins Array of extension names to load
166 function wfLoadSkins( array $skins ) {
167 global $wgStyleDirectory;
168 $registry = ExtensionRegistry
::getInstance();
169 foreach ( $skins as $skin ) {
170 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
175 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
180 function wfArrayDiff2( $a, $b ) {
181 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
185 * @param array|string $a
186 * @param array|string $b
189 function wfArrayDiff2_cmp( $a, $b ) {
190 if ( is_string( $a ) && is_string( $b ) ) {
191 return strcmp( $a, $b );
192 } elseif ( count( $a ) !== count( $b ) ) {
193 return count( $a ) < count( $b ) ?
-1 : 1;
197 while ( key( $a ) !== null && key( $b ) !== null ) {
198 $valueA = current( $a );
199 $valueB = current( $b );
200 $cmp = strcmp( $valueA, $valueB );
212 * Like array_filter with ARRAY_FILTER_USE_BOTH, but works pre-5.6.
215 * @param callable $callback Will be called with the array value and key (in that order) and
216 * should return a bool which will determine whether the array element is kept.
219 function wfArrayFilter( array $arr, callable
$callback ) {
220 if ( defined( 'ARRAY_FILTER_USE_BOTH' ) ) {
221 return array_filter( $arr, $callback, ARRAY_FILTER_USE_BOTH
);
223 $filteredKeys = array_filter( array_keys( $arr ), function ( $key ) use ( $arr, $callback ) {
224 return call_user_func( $callback, $arr[$key], $key );
226 return array_intersect_key( $arr, array_fill_keys( $filteredKeys, true ) );
230 * Like array_filter with ARRAY_FILTER_USE_KEY, but works pre-5.6.
233 * @param callable $callback Will be called with the array key and should return a bool which
234 * will determine whether the array element is kept.
237 function wfArrayFilterByKey( array $arr, callable
$callback ) {
238 return wfArrayFilter( $arr, function ( $val, $key ) use ( $callback ) {
239 return call_user_func( $callback, $key );
244 * Appends to second array if $value differs from that in $default
246 * @param string|int $key
247 * @param mixed $value
248 * @param mixed $default
249 * @param array &$changed Array to alter
250 * @throws MWException
252 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
253 if ( is_null( $changed ) ) {
254 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
256 if ( $default[$key] !== $value ) {
257 $changed[$key] = $value;
262 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
264 * wfMergeErrorArrays(
277 * @param array $array1,...
280 function wfMergeErrorArrays( /*...*/ ) {
281 $args = func_get_args();
283 foreach ( $args as $errors ) {
284 foreach ( $errors as $params ) {
285 $originalParams = $params;
286 if ( $params[0] instanceof MessageSpecifier
) {
288 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
290 # @todo FIXME: Sometimes get nested arrays for $params,
291 # which leads to E_NOTICEs
292 $spec = implode( "\t", $params );
293 $out[$spec] = $originalParams;
296 return array_values( $out );
300 * Insert array into another array after the specified *KEY*
302 * @param array $array The array.
303 * @param array $insert The array to insert.
304 * @param mixed $after The key to insert after
307 function wfArrayInsertAfter( array $array, array $insert, $after ) {
308 // Find the offset of the element to insert after.
309 $keys = array_keys( $array );
310 $offsetByKey = array_flip( $keys );
312 $offset = $offsetByKey[$after];
314 // Insert at the specified offset
315 $before = array_slice( $array, 0, $offset +
1, true );
316 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
318 $output = $before +
$insert +
$after;
324 * Recursively converts the parameter (an object) to an array with the same data
326 * @param object|array $objOrArray
327 * @param bool $recursive
330 function wfObjectToArray( $objOrArray, $recursive = true ) {
332 if ( is_object( $objOrArray ) ) {
333 $objOrArray = get_object_vars( $objOrArray );
335 foreach ( $objOrArray as $key => $value ) {
336 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
337 $value = wfObjectToArray( $value );
340 $array[$key] = $value;
347 * Get a random decimal value between 0 and 1, in a way
348 * not likely to give duplicate values for any realistic
349 * number of articles.
351 * @note This is designed for use in relation to Special:RandomPage
352 * and the page_random database field.
356 function wfRandom() {
357 // The maximum random value is "only" 2^31-1, so get two random
358 // values to reduce the chance of dupes
359 $max = mt_getrandmax() +
1;
360 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
365 * Get a random string containing a number of pseudo-random hex characters.
367 * @note This is not secure, if you are trying to generate some sort
368 * of token please use MWCryptRand instead.
370 * @param int $length The length of the string to generate
374 function wfRandomString( $length = 32 ) {
376 for ( $n = 0; $n < $length; $n +
= 7 ) {
377 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
379 return substr( $str, 0, $length );
383 * We want some things to be included as literal characters in our title URLs
384 * for prettiness, which urlencode encodes by default. According to RFC 1738,
385 * all of the following should be safe:
389 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
390 * character which should not be encoded. More importantly, google chrome
391 * always converts %7E back to ~, and converting it in this function can
392 * cause a redirect loop (T105265).
394 * But + is not safe because it's used to indicate a space; &= are only safe in
395 * paths and not in queries (and we don't distinguish here); ' seems kind of
396 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
397 * is reserved, we don't care. So the list we unescape is:
401 * However, IIS7 redirects fail when the url contains a colon (see T24709),
402 * so no fancy : for IIS7.
404 * %2F in the page titles seems to fatally break for some reason.
409 function wfUrlencode( $s ) {
412 if ( is_null( $s ) ) {
417 if ( is_null( $needle ) ) {
418 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
419 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
420 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
426 $s = urlencode( $s );
429 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
437 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
438 * "days=7&limit=100". Options in the first array override options in the second.
439 * Options set to null or false will not be output.
441 * @param array $array1 ( String|Array )
442 * @param array|null $array2 ( String|Array )
443 * @param string $prefix
446 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
447 if ( !is_null( $array2 ) ) {
448 $array1 = $array1 +
$array2;
452 foreach ( $array1 as $key => $value ) {
453 if ( !is_null( $value ) && $value !== false ) {
457 if ( $prefix !== '' ) {
458 $key = $prefix . "[$key]";
460 if ( is_array( $value ) ) {
462 foreach ( $value as $k => $v ) {
463 $cgi .= $firstTime ?
'' : '&';
464 if ( is_array( $v ) ) {
465 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
467 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
472 if ( is_object( $value ) ) {
473 $value = $value->__toString();
475 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
483 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
484 * its argument and returns the same string in array form. This allows compatibility
485 * with legacy functions that accept raw query strings instead of nice
486 * arrays. Of course, keys and values are urldecode()d.
488 * @param string $query Query string
489 * @return string[] Array version of input
491 function wfCgiToArray( $query ) {
492 if ( isset( $query[0] ) && $query[0] == '?' ) {
493 $query = substr( $query, 1 );
495 $bits = explode( '&', $query );
497 foreach ( $bits as $bit ) {
501 if ( strpos( $bit, '=' ) === false ) {
502 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
506 list( $key, $value ) = explode( '=', $bit );
508 $key = urldecode( $key );
509 $value = urldecode( $value );
510 if ( strpos( $key, '[' ) !== false ) {
511 $keys = array_reverse( explode( '[', $key ) );
512 $key = array_pop( $keys );
514 foreach ( $keys as $k ) {
515 $k = substr( $k, 0, -1 );
516 $temp = [ $k => $temp ];
518 if ( isset( $ret[$key] ) ) {
519 $ret[$key] = array_merge( $ret[$key], $temp );
531 * Append a query string to an existing URL, which may or may not already
532 * have query string parameters already. If so, they will be combined.
535 * @param string|string[] $query String or associative array
538 function wfAppendQuery( $url, $query ) {
539 if ( is_array( $query ) ) {
540 $query = wfArrayToCgi( $query );
542 if ( $query != '' ) {
543 // Remove the fragment, if there is one
545 $hashPos = strpos( $url, '#' );
546 if ( $hashPos !== false ) {
547 $fragment = substr( $url, $hashPos );
548 $url = substr( $url, 0, $hashPos );
552 if ( false === strpos( $url, '?' ) ) {
559 // Put the fragment back
560 if ( $fragment !== false ) {
568 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
571 * The meaning of the PROTO_* constants is as follows:
572 * PROTO_HTTP: Output a URL starting with http://
573 * PROTO_HTTPS: Output a URL starting with https://
574 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
575 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
576 * on which protocol was used for the current incoming request
577 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
578 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
579 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
581 * @todo this won't work with current-path-relative URLs
582 * like "subdir/foo.html", etc.
584 * @param string $url Either fully-qualified or a local path + query
585 * @param string $defaultProto One of the PROTO_* constants. Determines the
586 * protocol to use if $url or $wgServer is protocol-relative
587 * @return string|false Fully-qualified URL, current-path-relative URL or false if
588 * no valid URL can be constructed
590 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
591 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
593 if ( $defaultProto === PROTO_CANONICAL
) {
594 $serverUrl = $wgCanonicalServer;
595 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
596 // Make $wgInternalServer fall back to $wgServer if not set
597 $serverUrl = $wgInternalServer;
599 $serverUrl = $wgServer;
600 if ( $defaultProto === PROTO_CURRENT
) {
601 $defaultProto = $wgRequest->getProtocol() . '://';
605 // Analyze $serverUrl to obtain its protocol
606 $bits = wfParseUrl( $serverUrl );
607 $serverHasProto = $bits && $bits['scheme'] != '';
609 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
610 if ( $serverHasProto ) {
611 $defaultProto = $bits['scheme'] . '://';
613 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
614 // This really isn't supposed to happen. Fall back to HTTP in this
616 $defaultProto = PROTO_HTTP
;
620 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
622 if ( substr( $url, 0, 2 ) == '//' ) {
623 $url = $defaultProtoWithoutSlashes . $url;
624 } elseif ( substr( $url, 0, 1 ) == '/' ) {
625 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
626 // otherwise leave it alone.
627 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
630 $bits = wfParseUrl( $url );
632 // ensure proper port for HTTPS arrives in URL
633 // https://phabricator.wikimedia.org/T67184
634 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
635 $bits['port'] = $wgHttpsPort;
638 if ( $bits && isset( $bits['path'] ) ) {
639 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
640 return wfAssembleUrl( $bits );
644 } elseif ( substr( $url, 0, 1 ) != '/' ) {
645 # URL is a relative path
646 return wfRemoveDotSegments( $url );
649 # Expanded URL is not valid.
654 * This function will reassemble a URL parsed with wfParseURL. This is useful
655 * if you need to edit part of a URL and put it back together.
657 * This is the basic structure used (brackets contain keys for $urlParts):
658 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
660 * @todo Need to integrate this into wfExpandUrl (see T34168)
663 * @param array $urlParts URL parts, as output from wfParseUrl
664 * @return string URL assembled from its component parts
666 function wfAssembleUrl( $urlParts ) {
669 if ( isset( $urlParts['delimiter'] ) ) {
670 if ( isset( $urlParts['scheme'] ) ) {
671 $result .= $urlParts['scheme'];
674 $result .= $urlParts['delimiter'];
677 if ( isset( $urlParts['host'] ) ) {
678 if ( isset( $urlParts['user'] ) ) {
679 $result .= $urlParts['user'];
680 if ( isset( $urlParts['pass'] ) ) {
681 $result .= ':' . $urlParts['pass'];
686 $result .= $urlParts['host'];
688 if ( isset( $urlParts['port'] ) ) {
689 $result .= ':' . $urlParts['port'];
693 if ( isset( $urlParts['path'] ) ) {
694 $result .= $urlParts['path'];
697 if ( isset( $urlParts['query'] ) ) {
698 $result .= '?' . $urlParts['query'];
701 if ( isset( $urlParts['fragment'] ) ) {
702 $result .= '#' . $urlParts['fragment'];
709 * Remove all dot-segments in the provided URL path. For example,
710 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
711 * RFC3986 section 5.2.4.
713 * @todo Need to integrate this into wfExpandUrl (see T34168)
715 * @param string $urlPath URL path, potentially containing dot-segments
716 * @return string URL path with all dot-segments removed
718 function wfRemoveDotSegments( $urlPath ) {
721 $inputLength = strlen( $urlPath );
723 while ( $inputOffset < $inputLength ) {
724 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
725 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
726 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
727 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
730 if ( $prefixLengthTwo == './' ) {
731 # Step A, remove leading "./"
733 } elseif ( $prefixLengthThree == '../' ) {
734 # Step A, remove leading "../"
736 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
737 # Step B, replace leading "/.$" with "/"
739 $urlPath[$inputOffset] = '/';
740 } elseif ( $prefixLengthThree == '/./' ) {
741 # Step B, replace leading "/./" with "/"
743 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
744 # Step C, replace leading "/..$" with "/" and
745 # remove last path component in output
747 $urlPath[$inputOffset] = '/';
749 } elseif ( $prefixLengthFour == '/../' ) {
750 # Step C, replace leading "/../" with "/" and
751 # remove last path component in output
754 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
755 # Step D, remove "^.$"
757 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
758 # Step D, remove "^..$"
761 # Step E, move leading path segment to output
762 if ( $prefixLengthOne == '/' ) {
763 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
765 $slashPos = strpos( $urlPath, '/', $inputOffset );
767 if ( $slashPos === false ) {
768 $output .= substr( $urlPath, $inputOffset );
769 $inputOffset = $inputLength;
771 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
772 $inputOffset +
= $slashPos - $inputOffset;
777 $slashPos = strrpos( $output, '/' );
778 if ( $slashPos === false ) {
781 $output = substr( $output, 0, $slashPos );
790 * Returns a regular expression of url protocols
792 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
793 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
796 function wfUrlProtocols( $includeProtocolRelative = true ) {
797 global $wgUrlProtocols;
799 // Cache return values separately based on $includeProtocolRelative
800 static $withProtRel = null, $withoutProtRel = null;
801 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
802 if ( !is_null( $cachedValue ) ) {
806 // Support old-style $wgUrlProtocols strings, for backwards compatibility
807 // with LocalSettings files from 1.5
808 if ( is_array( $wgUrlProtocols ) ) {
810 foreach ( $wgUrlProtocols as $protocol ) {
811 // Filter out '//' if !$includeProtocolRelative
812 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
813 $protocols[] = preg_quote( $protocol, '/' );
817 $retval = implode( '|', $protocols );
819 // Ignore $includeProtocolRelative in this case
820 // This case exists for pre-1.6 compatibility, and we can safely assume
821 // that '//' won't appear in a pre-1.6 config because protocol-relative
822 // URLs weren't supported until 1.18
823 $retval = $wgUrlProtocols;
826 // Cache return value
827 if ( $includeProtocolRelative ) {
828 $withProtRel = $retval;
830 $withoutProtRel = $retval;
836 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
837 * you need a regex that matches all URL protocols but does not match protocol-
841 function wfUrlProtocolsWithoutProtRel() {
842 return wfUrlProtocols( false );
846 * parse_url() work-alike, but non-broken. Differences:
848 * 1) Does not raise warnings on bad URLs (just returns false).
849 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
850 * protocol-relative URLs) correctly.
851 * 3) Adds a "delimiter" element to the array (see (2)).
852 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
853 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
854 * a line feed character.
856 * @param string $url A URL to parse
857 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
859 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
860 * be an empty string for protocol-relative URLs.
861 * - delimiter: either '://', ':' or '//'. Always present.
862 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
863 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
864 * Missing when there is no username.
865 * - pass: password, same as above.
866 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
867 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
868 * - fragment: the part after #, can be missing.
870 function wfParseUrl( $url ) {
871 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
873 // Protocol-relative URLs are handled really badly by parse_url(). It's so
874 // bad that the easiest way to handle them is to just prepend 'http:' and
875 // strip the protocol out later.
876 $wasRelative = substr( $url, 0, 2 ) == '//';
877 if ( $wasRelative ) {
880 MediaWiki\
suppressWarnings();
881 $bits = parse_url( $url );
882 MediaWiki\restoreWarnings
();
883 // parse_url() returns an array without scheme for some invalid URLs, e.g.
884 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
885 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
889 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
890 $bits['scheme'] = strtolower( $bits['scheme'] );
892 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
893 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
894 $bits['delimiter'] = '://';
895 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
896 $bits['delimiter'] = ':';
897 // parse_url detects for news: and mailto: the host part of an url as path
898 // We have to correct this wrong detection
899 if ( isset( $bits['path'] ) ) {
900 $bits['host'] = $bits['path'];
907 /* Provide an empty host for eg. file:/// urls (see T30627) */
908 if ( !isset( $bits['host'] ) ) {
912 if ( isset( $bits['path'] ) ) {
913 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
914 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
915 $bits['path'] = '/' . $bits['path'];
922 // If the URL was protocol-relative, fix scheme and delimiter
923 if ( $wasRelative ) {
924 $bits['scheme'] = '';
925 $bits['delimiter'] = '//';
931 * Take a URL, make sure it's expanded to fully qualified, and replace any
932 * encoded non-ASCII Unicode characters with their UTF-8 original forms
933 * for more compact display and legibility for local audiences.
935 * @todo handle punycode domains too
940 function wfExpandIRI( $url ) {
941 return preg_replace_callback(
942 '/((?:%[89A-F][0-9A-F])+)/i',
943 'wfExpandIRI_callback',
949 * Private callback for wfExpandIRI
950 * @param array $matches
953 function wfExpandIRI_callback( $matches ) {
954 return urldecode( $matches[1] );
958 * Make URL indexes, appropriate for the el_index field of externallinks.
963 function wfMakeUrlIndexes( $url ) {
964 $bits = wfParseUrl( $url );
966 // Reverse the labels in the hostname, convert to lower case
967 // For emails reverse domainpart only
968 if ( $bits['scheme'] == 'mailto' ) {
969 $mailparts = explode( '@', $bits['host'], 2 );
970 if ( count( $mailparts ) === 2 ) {
971 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
973 // No domain specified, don't mangle it
976 $reversedHost = $domainpart . '@' . $mailparts[0];
978 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
980 // Add an extra dot to the end
981 // Why? Is it in wrong place in mailto links?
982 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
983 $reversedHost .= '.';
985 // Reconstruct the pseudo-URL
986 $prot = $bits['scheme'];
987 $index = $prot . $bits['delimiter'] . $reversedHost;
988 // Leave out user and password. Add the port, path, query and fragment
989 if ( isset( $bits['port'] ) ) {
990 $index .= ':' . $bits['port'];
992 if ( isset( $bits['path'] ) ) {
993 $index .= $bits['path'];
997 if ( isset( $bits['query'] ) ) {
998 $index .= '?' . $bits['query'];
1000 if ( isset( $bits['fragment'] ) ) {
1001 $index .= '#' . $bits['fragment'];
1004 if ( $prot == '' ) {
1005 return [ "http:$index", "https:$index" ];
1012 * Check whether a given URL has a domain that occurs in a given set of domains
1013 * @param string $url
1014 * @param array $domains Array of domains (strings)
1015 * @return bool True if the host part of $url ends in one of the strings in $domains
1017 function wfMatchesDomainList( $url, $domains ) {
1018 $bits = wfParseUrl( $url );
1019 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1020 $host = '.' . $bits['host'];
1021 foreach ( (array)$domains as $domain ) {
1022 $domain = '.' . $domain;
1023 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1032 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1033 * In normal operation this is a NOP.
1035 * Controlling globals:
1036 * $wgDebugLogFile - points to the log file
1037 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1038 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1040 * @since 1.25 support for additional context data
1042 * @param string $text
1043 * @param string|bool $dest Destination of the message:
1044 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1045 * - 'private': excluded from HTML output
1046 * For backward compatibility, it can also take a boolean:
1047 * - true: same as 'all'
1048 * - false: same as 'private'
1049 * @param array $context Additional logging context data
1051 function wfDebug( $text, $dest = 'all', array $context = [] ) {
1052 global $wgDebugRawPage, $wgDebugLogPrefix;
1053 global $wgDebugTimestamps, $wgRequestTime;
1055 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1059 $text = trim( $text );
1061 if ( $wgDebugTimestamps ) {
1062 $context['seconds_elapsed'] = sprintf(
1064 microtime( true ) - $wgRequestTime
1066 $context['memory_used'] = sprintf(
1068 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1072 if ( $wgDebugLogPrefix !== '' ) {
1073 $context['prefix'] = $wgDebugLogPrefix;
1075 $context['private'] = ( $dest === false ||
$dest === 'private' );
1077 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1078 $logger->debug( $text, $context );
1082 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1085 function wfIsDebugRawPage() {
1087 if ( $cache !== null ) {
1090 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1091 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1093 isset( $_SERVER['SCRIPT_NAME'] )
1094 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1105 * Send a line giving PHP memory usage.
1107 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1109 function wfDebugMem( $exact = false ) {
1110 $mem = memory_get_usage();
1112 $mem = floor( $mem / 1024 ) . ' KiB';
1116 wfDebug( "Memory usage: $mem\n" );
1120 * Send a line to a supplementary debug log file, if configured, or main debug
1123 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1124 * a string filename or an associative array mapping 'destination' to the
1125 * desired filename. The associative array may also contain a 'sample' key
1126 * with an integer value, specifying a sampling factor. Sampled log events
1127 * will be emitted with a 1 in N random chance.
1129 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1130 * @since 1.25 support for additional context data
1131 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1133 * @param string $logGroup
1134 * @param string $text
1135 * @param string|bool $dest Destination of the message:
1136 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1137 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1138 * discarded otherwise
1139 * For backward compatibility, it can also take a boolean:
1140 * - true: same as 'all'
1141 * - false: same as 'private'
1142 * @param array $context Additional logging context data
1144 function wfDebugLog(
1145 $logGroup, $text, $dest = 'all', array $context = []
1147 $text = trim( $text );
1149 $logger = LoggerFactory
::getInstance( $logGroup );
1150 $context['private'] = ( $dest === false ||
$dest === 'private' );
1151 $logger->info( $text, $context );
1155 * Log for database errors
1157 * @since 1.25 support for additional context data
1159 * @param string $text Database error message.
1160 * @param array $context Additional logging context data
1162 function wfLogDBError( $text, array $context = [] ) {
1163 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1164 $logger->error( trim( $text ), $context );
1168 * Throws a warning that $function is deprecated
1170 * @param string $function
1171 * @param string|bool $version Version of MediaWiki that the function
1172 * was deprecated in (Added in 1.19).
1173 * @param string|bool $component Added in 1.19.
1174 * @param int $callerOffset How far up the call stack is the original
1175 * caller. 2 = function that called the function that called
1176 * wfDeprecated (Added in 1.20)
1180 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1181 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1185 * Send a warning either to the debug log or in a PHP error depending on
1186 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1188 * @param string $msg Message to send
1189 * @param int $callerOffset Number of items to go back in the backtrace to
1190 * find the correct caller (1 = function calling wfWarn, ...)
1191 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1192 * only used when $wgDevelopmentWarnings is true
1194 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1195 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1199 * Send a warning as a PHP error and the debug log. This is intended for logging
1200 * warnings in production. For logging development warnings, use WfWarn instead.
1202 * @param string $msg Message to send
1203 * @param int $callerOffset Number of items to go back in the backtrace to
1204 * find the correct caller (1 = function calling wfLogWarning, ...)
1205 * @param int $level PHP error level; defaults to E_USER_WARNING
1207 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1208 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1212 * Log to a file without getting "file size exceeded" signals.
1214 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1215 * send lines to the specified port, prefixed by the specified prefix and a space.
1216 * @since 1.25 support for additional context data
1218 * @param string $text
1219 * @param string $file Filename
1220 * @param array $context Additional logging context data
1221 * @throws MWException
1222 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1224 function wfErrorLog( $text, $file, array $context = [] ) {
1225 wfDeprecated( __METHOD__
, '1.25' );
1226 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1227 $context['destination'] = $file;
1228 $logger->info( trim( $text ), $context );
1233 * @todo Move logic to MediaWiki.php
1235 function wfLogProfilingData() {
1236 global $wgDebugLogGroups, $wgDebugRawPage;
1238 $context = RequestContext
::getMain();
1239 $request = $context->getRequest();
1241 $profiler = Profiler
::instance();
1242 $profiler->setContext( $context );
1243 $profiler->logData();
1245 // Send out any buffered statsd metrics as needed
1246 MediaWiki
::emitBufferedStatsdData(
1247 MediaWikiServices
::getInstance()->getStatsdDataFactory(),
1248 $context->getConfig()
1251 // Profiling must actually be enabled...
1252 if ( $profiler instanceof ProfilerStub
) {
1256 if ( isset( $wgDebugLogGroups['profileoutput'] )
1257 && $wgDebugLogGroups['profileoutput'] === false
1259 // Explicitly disabled
1262 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1266 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1267 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1268 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1270 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1271 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1273 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1274 $ctx['from'] = $_SERVER['HTTP_FROM'];
1276 if ( isset( $ctx['forwarded_for'] ) ||
1277 isset( $ctx['client_ip'] ) ||
1278 isset( $ctx['from'] ) ) {
1279 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1282 // Don't load $wgUser at this late stage just for statistics purposes
1283 // @todo FIXME: We can detect some anons even if it is not loaded.
1284 // See User::getId()
1285 $user = $context->getUser();
1286 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1288 // Command line script uses a FauxRequest object which does not have
1289 // any knowledge about an URL and throw an exception instead.
1291 $ctx['url'] = urldecode( $request->getRequestURL() );
1292 } catch ( Exception
$ignored ) {
1296 $ctx['output'] = $profiler->getOutput();
1298 $log = LoggerFactory
::getInstance( 'profileoutput' );
1299 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1303 * Increment a statistics counter
1305 * @param string $key
1309 function wfIncrStats( $key, $count = 1 ) {
1310 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1311 $stats->updateCount( $key, $count );
1315 * Check whether the wiki is in read-only mode.
1319 function wfReadOnly() {
1320 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1325 * Check if the site is in read-only mode and return the message if so
1327 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1328 * for replica DB lag. This may result in DB connection being made.
1330 * @return string|bool String when in read-only mode; false otherwise
1332 function wfReadOnlyReason() {
1333 return MediaWikiServices
::getInstance()->getReadOnlyMode()
1338 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1340 * @return string|bool String when in read-only mode; false otherwise
1343 function wfConfiguredReadOnlyReason() {
1344 return MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1349 * Return a Language object from $langcode
1351 * @param Language|string|bool $langcode Either:
1352 * - a Language object
1353 * - code of the language to get the message for, if it is
1354 * a valid code create a language for that language, if
1355 * it is a string but not a valid code then make a basic
1357 * - a boolean: if it's false then use the global object for
1358 * the current user's language (as a fallback for the old parameter
1359 * functionality), or if it is true then use global object
1360 * for the wiki's content language.
1363 function wfGetLangObj( $langcode = false ) {
1364 # Identify which language to get or create a language object for.
1365 # Using is_object here due to Stub objects.
1366 if ( is_object( $langcode ) ) {
1367 # Great, we already have the object (hopefully)!
1371 global $wgContLang, $wgLanguageCode;
1372 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1373 # $langcode is the language code of the wikis content language object.
1374 # or it is a boolean and value is true
1379 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1380 # $langcode is the language code of user language object.
1381 # or it was a boolean and value is false
1385 $validCodes = array_keys( Language
::fetchLanguageNames() );
1386 if ( in_array( $langcode, $validCodes ) ) {
1387 # $langcode corresponds to a valid language.
1388 return Language
::factory( $langcode );
1391 # $langcode is a string, but not a valid language code; use content language.
1392 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1397 * This is the function for getting translated interface messages.
1399 * @see Message class for documentation how to use them.
1400 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1402 * This function replaces all old wfMsg* functions.
1404 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1405 * @param mixed $params,... Normal message parameters
1410 * @see Message::__construct
1412 function wfMessage( $key /*...*/ ) {
1413 $message = new Message( $key );
1415 // We call Message::params() to reduce code duplication
1416 $params = func_get_args();
1417 array_shift( $params );
1419 call_user_func_array( [ $message, 'params' ], $params );
1426 * This function accepts multiple message keys and returns a message instance
1427 * for the first message which is non-empty. If all messages are empty then an
1428 * instance of the first message key is returned.
1430 * @param string|string[] $keys,... Message keys
1435 * @see Message::newFallbackSequence
1437 function wfMessageFallback( /*...*/ ) {
1438 $args = func_get_args();
1439 return call_user_func_array( 'Message::newFallbackSequence', $args );
1443 * Replace message parameter keys on the given formatted output.
1445 * @param string $message
1446 * @param array $args
1450 function wfMsgReplaceArgs( $message, $args ) {
1451 # Fix windows line-endings
1452 # Some messages are split with explode("\n", $msg)
1453 $message = str_replace( "\r", '', $message );
1455 // Replace arguments
1456 if ( is_array( $args ) && $args ) {
1457 if ( is_array( $args[0] ) ) {
1458 $args = array_values( $args[0] );
1460 $replacementKeys = [];
1461 foreach ( $args as $n => $param ) {
1462 $replacementKeys['$' . ( $n +
1 )] = $param;
1464 $message = strtr( $message, $replacementKeys );
1471 * Fetch server name for use in error reporting etc.
1472 * Use real server name if available, so we know which machine
1473 * in a server farm generated the current page.
1477 function wfHostname() {
1479 if ( is_null( $host ) ) {
1480 # Hostname overriding
1481 global $wgOverrideHostname;
1482 if ( $wgOverrideHostname !== false ) {
1483 # Set static and skip any detection
1484 $host = $wgOverrideHostname;
1488 if ( function_exists( 'posix_uname' ) ) {
1489 // This function not present on Windows
1490 $uname = posix_uname();
1494 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1495 $host = $uname['nodename'];
1496 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1497 # Windows computer name
1498 $host = getenv( 'COMPUTERNAME' );
1500 # This may be a virtual server.
1501 $host = $_SERVER['SERVER_NAME'];
1508 * Returns a script tag that stores the amount of time it took MediaWiki to
1509 * handle the request in milliseconds as 'wgBackendResponseTime'.
1511 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1512 * hostname of the server handling the request.
1516 function wfReportTime() {
1517 global $wgRequestTime, $wgShowHostnames;
1519 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1520 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1521 if ( $wgShowHostnames ) {
1522 $reportVars['wgHostname'] = wfHostname();
1524 return Skin
::makeVariablesScript( $reportVars );
1528 * Safety wrapper for debug_backtrace().
1530 * Will return an empty array if debug_backtrace is disabled, otherwise
1531 * the output from debug_backtrace() (trimmed).
1533 * @param int $limit This parameter can be used to limit the number of stack frames returned
1535 * @return array Array of backtrace information
1537 function wfDebugBacktrace( $limit = 0 ) {
1538 static $disabled = null;
1540 if ( is_null( $disabled ) ) {
1541 $disabled = !function_exists( 'debug_backtrace' );
1543 wfDebug( "debug_backtrace() is disabled\n" );
1551 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1553 return array_slice( debug_backtrace(), 1 );
1558 * Get a debug backtrace as a string
1560 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1561 * Defaults to $wgCommandLineMode if unset.
1563 * @since 1.25 Supports $raw parameter.
1565 function wfBacktrace( $raw = null ) {
1566 global $wgCommandLineMode;
1568 if ( $raw === null ) {
1569 $raw = $wgCommandLineMode;
1573 $frameFormat = "%s line %s calls %s()\n";
1574 $traceFormat = "%s";
1576 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1577 $traceFormat = "<ul>\n%s</ul>\n";
1580 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1581 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1582 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1583 $call = $frame['function'];
1584 if ( !empty( $frame['class'] ) ) {
1585 $call = $frame['class'] . $frame['type'] . $call;
1587 return sprintf( $frameFormat, $file, $line, $call );
1588 }, wfDebugBacktrace() );
1590 return sprintf( $traceFormat, implode( '', $frames ) );
1594 * Get the name of the function which called this function
1595 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1596 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1597 * wfGetCaller( 3 ) is the parent of that.
1602 function wfGetCaller( $level = 2 ) {
1603 $backtrace = wfDebugBacktrace( $level +
1 );
1604 if ( isset( $backtrace[$level] ) ) {
1605 return wfFormatStackFrame( $backtrace[$level] );
1612 * Return a string consisting of callers in the stack. Useful sometimes
1613 * for profiling specific points.
1615 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1618 function wfGetAllCallers( $limit = 3 ) {
1619 $trace = array_reverse( wfDebugBacktrace() );
1620 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1621 $limit = count( $trace ) - 1;
1623 $trace = array_slice( $trace, -$limit - 1, $limit );
1624 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1628 * Return a string representation of frame
1630 * @param array $frame
1633 function wfFormatStackFrame( $frame ) {
1634 if ( !isset( $frame['function'] ) ) {
1635 return 'NO_FUNCTION_GIVEN';
1637 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1638 $frame['class'] . $frame['type'] . $frame['function'] :
1642 /* Some generic result counters, pulled out of SearchEngine */
1647 * @param int $offset
1651 function wfShowingResults( $offset, $limit ) {
1652 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1656 * Whether the client accept gzip encoding
1658 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1659 * Use this when considering to send a gzip-encoded response to the client.
1661 * @param bool $force Forces another check even if we already have a cached result.
1664 function wfClientAcceptsGzip( $force = false ) {
1665 static $result = null;
1666 if ( $result === null ||
$force ) {
1668 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1669 # @todo FIXME: We may want to blacklist some broken browsers
1672 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1673 $_SERVER['HTTP_ACCEPT_ENCODING'],
1677 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1681 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1690 * Escapes the given text so that it may be output using addWikiText()
1691 * without any linking, formatting, etc. making its way through. This
1692 * is achieved by substituting certain characters with HTML entities.
1693 * As required by the callers, "<nowiki>" is not used.
1695 * @param string $text Text to be escaped
1698 function wfEscapeWikiText( $text ) {
1699 global $wgEnableMagicLinks;
1700 static $repl = null, $repl2 = null;
1701 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1702 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1703 // in those situations
1705 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1706 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1707 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1708 "\n#" => "\n#", "\r#" => "\r#",
1709 "\n*" => "\n*", "\r*" => "\r*",
1710 "\n:" => "\n:", "\r:" => "\r:",
1711 "\n " => "\n ", "\r " => "\r ",
1712 "\n\n" => "\n ", "\r\n" => " \n",
1713 "\n\r" => "\n ", "\r\r" => "\r ",
1714 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1715 "\n----" => "\n----", "\r----" => "\r----",
1716 '__' => '__', '://' => '://',
1719 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1720 // We have to catch everything "\s" matches in PCRE
1721 foreach ( $magicLinks as $magic ) {
1722 $repl["$magic "] = "$magic ";
1723 $repl["$magic\t"] = "$magic	";
1724 $repl["$magic\r"] = "$magic ";
1725 $repl["$magic\n"] = "$magic ";
1726 $repl["$magic\f"] = "$magic";
1729 // And handle protocols that don't use "://"
1730 global $wgUrlProtocols;
1732 foreach ( $wgUrlProtocols as $prot ) {
1733 if ( substr( $prot, -1 ) === ':' ) {
1734 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1737 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1739 $text = substr( strtr( "\n$text", $repl ), 1 );
1740 $text = preg_replace( $repl2, '$1:', $text );
1745 * Sets dest to source and returns the original value of dest
1746 * If source is NULL, it just returns the value, it doesn't set the variable
1747 * If force is true, it will set the value even if source is NULL
1749 * @param mixed &$dest
1750 * @param mixed $source
1751 * @param bool $force
1754 function wfSetVar( &$dest, $source, $force = false ) {
1756 if ( !is_null( $source ) ||
$force ) {
1763 * As for wfSetVar except setting a bit
1767 * @param bool $state
1771 function wfSetBit( &$dest, $bit, $state = true ) {
1772 $temp = (bool)( $dest & $bit );
1773 if ( !is_null( $state ) ) {
1784 * A wrapper around the PHP function var_export().
1785 * Either print it or add it to the regular output ($wgOut).
1787 * @param mixed $var A PHP variable to dump.
1789 function wfVarDump( $var ) {
1791 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1792 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1795 $wgOut->addHTML( $s );
1800 * Provide a simple HTTP error.
1802 * @param int|string $code
1803 * @param string $label
1804 * @param string $desc
1806 function wfHttpError( $code, $label, $desc ) {
1808 HttpStatus
::header( $code );
1811 $wgOut->sendCacheControl();
1814 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1815 header( 'Content-type: text/html; charset=utf-8' );
1816 print '<!DOCTYPE html>' .
1817 '<html><head><title>' .
1818 htmlspecialchars( $label ) .
1819 '</title></head><body><h1>' .
1820 htmlspecialchars( $label ) .
1822 nl2br( htmlspecialchars( $desc ) ) .
1823 "</p></body></html>\n";
1827 * Clear away any user-level output buffers, discarding contents.
1829 * Suitable for 'starting afresh', for instance when streaming
1830 * relatively large amounts of data without buffering, or wanting to
1831 * output image files without ob_gzhandler's compression.
1833 * The optional $resetGzipEncoding parameter controls suppression of
1834 * the Content-Encoding header sent by ob_gzhandler; by default it
1835 * is left. See comments for wfClearOutputBuffers() for why it would
1838 * Note that some PHP configuration options may add output buffer
1839 * layers which cannot be removed; these are left in place.
1841 * @param bool $resetGzipEncoding
1843 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1844 if ( $resetGzipEncoding ) {
1845 // Suppress Content-Encoding and Content-Length
1846 // headers from 1.10+s wfOutputHandler
1847 global $wgDisableOutputCompression;
1848 $wgDisableOutputCompression = true;
1850 while ( $status = ob_get_status() ) {
1851 if ( isset( $status['flags'] ) ) {
1852 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1853 $deleteable = ( $status['flags'] & $flags ) === $flags;
1854 } elseif ( isset( $status['del'] ) ) {
1855 $deleteable = $status['del'];
1857 // Guess that any PHP-internal setting can't be removed.
1858 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1860 if ( !$deleteable ) {
1861 // Give up, and hope the result doesn't break
1865 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1866 // Unit testing barrier to prevent this function from breaking PHPUnit.
1869 if ( !ob_end_clean() ) {
1870 // Could not remove output buffer handler; abort now
1871 // to avoid getting in some kind of infinite loop.
1874 if ( $resetGzipEncoding ) {
1875 if ( $status['name'] == 'ob_gzhandler' ) {
1876 // Reset the 'Content-Encoding' field set by this handler
1877 // so we can start fresh.
1878 header_remove( 'Content-Encoding' );
1886 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1888 * Clear away output buffers, but keep the Content-Encoding header
1889 * produced by ob_gzhandler, if any.
1891 * This should be used for HTTP 304 responses, where you need to
1892 * preserve the Content-Encoding header of the real result, but
1893 * also need to suppress the output of ob_gzhandler to keep to spec
1894 * and avoid breaking Firefox in rare cases where the headers and
1895 * body are broken over two packets.
1897 function wfClearOutputBuffers() {
1898 wfResetOutputBuffers( false );
1902 * Converts an Accept-* header into an array mapping string values to quality
1905 * @param string $accept
1906 * @param string $def Default
1907 * @return float[] Associative array of string => float pairs
1909 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1910 # No arg means accept anything (per HTTP spec)
1912 return [ $def => 1.0 ];
1917 $parts = explode( ',', $accept );
1919 foreach ( $parts as $part ) {
1920 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1921 $values = explode( ';', trim( $part ) );
1923 if ( count( $values ) == 1 ) {
1924 $prefs[$values[0]] = 1.0;
1925 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1926 $prefs[$values[0]] = floatval( $match[1] );
1934 * Checks if a given MIME type matches any of the keys in the given
1935 * array. Basic wildcards are accepted in the array keys.
1937 * Returns the matching MIME type (or wildcard) if a match, otherwise
1940 * @param string $type
1941 * @param array $avail
1945 function mimeTypeMatch( $type, $avail ) {
1946 if ( array_key_exists( $type, $avail ) ) {
1949 $mainType = explode( '/', $type )[0];
1950 if ( array_key_exists( "$mainType/*", $avail ) ) {
1951 return "$mainType/*";
1952 } elseif ( array_key_exists( '*/*', $avail ) ) {
1961 * Returns the 'best' match between a client's requested internet media types
1962 * and the server's list of available types. Each list should be an associative
1963 * array of type to preference (preference is a float between 0.0 and 1.0).
1964 * Wildcards in the types are acceptable.
1966 * @param array $cprefs Client's acceptable type list
1967 * @param array $sprefs Server's offered types
1970 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1971 * XXX: generalize to negotiate other stuff
1973 function wfNegotiateType( $cprefs, $sprefs ) {
1976 foreach ( array_keys( $sprefs ) as $type ) {
1977 $subType = explode( '/', $type )[1];
1978 if ( $subType != '*' ) {
1979 $ckey = mimeTypeMatch( $type, $cprefs );
1981 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1986 foreach ( array_keys( $cprefs ) as $type ) {
1987 $subType = explode( '/', $type )[1];
1988 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1989 $skey = mimeTypeMatch( $type, $sprefs );
1991 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1999 foreach ( array_keys( $combine ) as $type ) {
2000 if ( $combine[$type] > $bestq ) {
2002 $bestq = $combine[$type];
2010 * Reference-counted warning suppression
2012 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
2015 function wfSuppressWarnings( $end = false ) {
2016 MediaWiki\
suppressWarnings( $end );
2020 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
2021 * Restore error level to previous value
2023 function wfRestoreWarnings() {
2024 MediaWiki\
suppressWarnings( true );
2028 * Get a timestamp string in one of various formats
2030 * @param mixed $outputtype A timestamp in one of the supported formats, the
2031 * function will autodetect which format is supplied and act accordingly.
2032 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2033 * @return string|bool String / false The same date in the format specified in $outputtype or false
2035 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2036 $ret = MWTimestamp
::convert( $outputtype, $ts );
2037 if ( $ret === false ) {
2038 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2044 * Return a formatted timestamp, or null if input is null.
2045 * For dealing with nullable timestamp columns in the database.
2047 * @param int $outputtype
2051 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2052 if ( is_null( $ts ) ) {
2055 return wfTimestamp( $outputtype, $ts );
2060 * Convenience function; returns MediaWiki timestamp for the present time.
2064 function wfTimestampNow() {
2066 return MWTimestamp
::now( TS_MW
);
2070 * Check if the operating system is Windows
2072 * @return bool True if it's Windows, false otherwise.
2074 function wfIsWindows() {
2075 static $isWindows = null;
2076 if ( $isWindows === null ) {
2077 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2083 * Check if we are running under HHVM
2087 function wfIsHHVM() {
2088 return defined( 'HHVM_VERSION' );
2092 * Check if we are running from the commandline
2097 function wfIsCLI() {
2098 return PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg';
2102 * Tries to get the system directory for temporary files. First
2103 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2104 * environment variables are then checked in sequence, then
2105 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2107 * NOTE: When possible, use instead the tmpfile() function to create
2108 * temporary files to avoid race conditions on file creation, etc.
2112 function wfTempDir() {
2113 global $wgTmpDirectory;
2115 if ( $wgTmpDirectory !== false ) {
2116 return $wgTmpDirectory;
2119 return TempFSFile
::getUsableTempDirectory();
2123 * Make directory, and make all parent directories if they don't exist
2125 * @param string $dir Full path to directory to create
2126 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2127 * @param string $caller Optional caller param for debugging.
2128 * @throws MWException
2131 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2132 global $wgDirectoryMode;
2134 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2135 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2138 if ( !is_null( $caller ) ) {
2139 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2142 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2146 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2148 if ( is_null( $mode ) ) {
2149 $mode = $wgDirectoryMode;
2152 // Turn off the normal warning, we're doing our own below
2153 MediaWiki\
suppressWarnings();
2154 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2155 MediaWiki\restoreWarnings
();
2158 // directory may have been created on another request since we last checked
2159 if ( is_dir( $dir ) ) {
2163 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2164 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2170 * Remove a directory and all its content.
2171 * Does not hide error.
2172 * @param string $dir
2174 function wfRecursiveRemoveDir( $dir ) {
2175 wfDebug( __FUNCTION__
. "( $dir )\n" );
2176 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2177 if ( is_dir( $dir ) ) {
2178 $objects = scandir( $dir );
2179 foreach ( $objects as $object ) {
2180 if ( $object != "." && $object != ".." ) {
2181 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2182 wfRecursiveRemoveDir( $dir . '/' . $object );
2184 unlink( $dir . '/' . $object );
2194 * @param int $nr The number to format
2195 * @param int $acc The number of digits after the decimal point, default 2
2196 * @param bool $round Whether or not to round the value, default true
2199 function wfPercent( $nr, $acc = 2, $round = true ) {
2200 $ret = sprintf( "%.${acc}f", $nr );
2201 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2205 * Safety wrapper around ini_get() for boolean settings.
2206 * The values returned from ini_get() are pre-normalized for settings
2207 * set via php.ini or php_flag/php_admin_flag... but *not*
2208 * for those set via php_value/php_admin_value.
2210 * It's fairly common for people to use php_value instead of php_flag,
2211 * which can leave you with an 'off' setting giving a false positive
2212 * for code that just takes the ini_get() return value as a boolean.
2214 * To make things extra interesting, setting via php_value accepts
2215 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2216 * Unrecognized values go false... again opposite PHP's own coercion
2217 * from string to bool.
2219 * Luckily, 'properly' set settings will always come back as '0' or '1',
2220 * so we only have to worry about them and the 'improper' settings.
2222 * I frickin' hate PHP... :P
2224 * @param string $setting
2227 function wfIniGetBool( $setting ) {
2228 return wfStringToBool( ini_get( $setting ) );
2232 * Convert string value to boolean, when the following are interpreted as true:
2236 * - Any number, except 0
2237 * All other strings are interpreted as false.
2239 * @param string $val
2243 function wfStringToBool( $val ) {
2244 $val = strtolower( $val );
2245 // 'on' and 'true' can't have whitespace around them, but '1' can.
2249 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2253 * Version of escapeshellarg() that works better on Windows.
2255 * Originally, this fixed the incorrect use of single quotes on Windows
2256 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2257 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2259 * @param string $args,... strings to escape and glue together,
2260 * or a single array of strings parameter
2262 * @deprecated since 1.30 use MediaWiki\Shell::escape()
2264 function wfEscapeShellArg( /*...*/ ) {
2265 $args = func_get_args();
2267 return call_user_func_array( Shell
::class . '::escape', $args );
2271 * Check if wfShellExec() is effectively disabled via php.ini config
2273 * @return bool|string False or 'disabled'
2275 * @deprecated since 1.30 use MediaWiki\Shell::isDisabled()
2277 function wfShellExecDisabled() {
2278 wfDeprecated( __FUNCTION__
, '1.30' );
2279 return Shell
::isDisabled() ?
'disabled' : false;
2283 * Execute a shell command, with time and memory limits mirrored from the PHP
2284 * configuration if supported.
2286 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2287 * or an array of unescaped arguments, in which case each value will be escaped
2288 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2289 * @param null|mixed &$retval Optional, will receive the program's exit code.
2290 * (non-zero is usually failure). If there is an error from
2291 * read, select, or proc_open(), this will be set to -1.
2292 * @param array $environ Optional environment variables which should be
2293 * added to the executed command environment.
2294 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2295 * this overwrites the global wgMaxShell* limits.
2296 * @param array $options Array of options:
2297 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2298 * including errors from limit.sh
2299 * - profileMethod: By default this function will profile based on the calling
2300 * method. Set this to a string for an alternative method to profile from
2302 * @return string Collected stdout as a string
2303 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2305 function wfShellExec( $cmd, &$retval = null, $environ = [],
2306 $limits = [], $options = []
2308 if ( Shell
::isDisabled() ) {
2310 // Backwards compatibility be upon us...
2311 return 'Unable to run external programs, proc_open() is disabled.';
2314 if ( is_array( $cmd ) ) {
2315 $cmd = Shell
::escape( $cmd );
2318 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2319 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2322 $result = Shell
::command( [] )
2323 ->unsafeParams( (array)$cmd )
2324 ->environment( $environ )
2326 ->includeStderr( $includeStderr )
2327 ->profileMethod( $profileMethod )
2329 } catch ( ProcOpenError
$ex ) {
2334 $retval = $result->getExitCode();
2336 return $result->getStdout();
2340 * Execute a shell command, returning both stdout and stderr. Convenience
2341 * function, as all the arguments to wfShellExec can become unwieldy.
2343 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2344 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2345 * or an array of unescaped arguments, in which case each value will be escaped
2346 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2347 * @param null|mixed &$retval Optional, will receive the program's exit code.
2348 * (non-zero is usually failure)
2349 * @param array $environ Optional environment variables which should be
2350 * added to the executed command environment.
2351 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2352 * this overwrites the global wgMaxShell* limits.
2353 * @return string Collected stdout and stderr as a string
2354 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2356 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2357 return wfShellExec( $cmd, $retval, $environ, $limits,
2358 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2362 * Formerly set the locale for locale-sensitive operations
2364 * This is now done in Setup.php.
2366 * @deprecated since 1.30, no longer needed
2367 * @see $wgShellLocale
2369 function wfInitShellLocale() {
2370 wfDeprecated( __FUNCTION__
, '1.30' );
2374 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2375 * Note that $parameters should be a flat array and an option with an argument
2376 * should consist of two consecutive items in the array (do not use "--option value").
2378 * @param string $script MediaWiki cli script path
2379 * @param array $parameters Arguments and options to the script
2380 * @param array $options Associative array of options:
2381 * 'php': The path to the php executable
2382 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2385 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2387 // Give site config file a chance to run the script in a wrapper.
2388 // The caller may likely want to call wfBasename() on $script.
2389 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2390 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
2391 if ( isset( $options['wrapper'] ) ) {
2392 $cmd[] = $options['wrapper'];
2395 // Escape each parameter for shell
2396 return Shell
::escape( array_merge( $cmd, $parameters ) );
2400 * wfMerge attempts to merge differences between three texts.
2401 * Returns true for a clean merge and false for failure or a conflict.
2403 * @param string $old
2404 * @param string $mine
2405 * @param string $yours
2406 * @param string &$result
2407 * @param string &$mergeAttemptResult
2410 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2413 # This check may also protect against code injection in
2414 # case of broken installations.
2415 MediaWiki\
suppressWarnings();
2416 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2417 MediaWiki\restoreWarnings
();
2419 if ( !$haveDiff3 ) {
2420 wfDebug( "diff3 not found\n" );
2424 # Make temporary files
2426 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2427 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2428 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2430 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2431 # a newline character. To avoid this, we normalize the trailing whitespace before
2432 # creating the diff.
2434 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2435 fclose( $oldtextFile );
2436 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2437 fclose( $mytextFile );
2438 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2439 fclose( $yourtextFile );
2441 # Check for a conflict
2442 $cmd = Shell
::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2443 $oldtextName, $yourtextName );
2444 $handle = popen( $cmd, 'r' );
2446 $mergeAttemptResult = '';
2448 $data = fread( $handle, 8192 );
2449 if ( strlen( $data ) == 0 ) {
2452 $mergeAttemptResult .= $data;
2456 $conflict = $mergeAttemptResult !== '';
2459 $cmd = Shell
::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2460 $oldtextName, $yourtextName );
2461 $handle = popen( $cmd, 'r' );
2464 $data = fread( $handle, 8192 );
2465 if ( strlen( $data ) == 0 ) {
2471 unlink( $mytextName );
2472 unlink( $oldtextName );
2473 unlink( $yourtextName );
2475 if ( $result === '' && $old !== '' && !$conflict ) {
2476 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2483 * Returns unified plain-text diff of two texts.
2484 * "Useful" for machine processing of diffs.
2486 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2488 * @param string $before The text before the changes.
2489 * @param string $after The text after the changes.
2490 * @param string $params Command-line options for the diff command.
2491 * @return string Unified diff of $before and $after
2493 function wfDiff( $before, $after, $params = '-u' ) {
2494 if ( $before == $after ) {
2499 MediaWiki\
suppressWarnings();
2500 $haveDiff = $wgDiff && file_exists( $wgDiff );
2501 MediaWiki\restoreWarnings
();
2503 # This check may also protect against code injection in
2504 # case of broken installations.
2506 wfDebug( "diff executable not found\n" );
2507 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2508 $format = new UnifiedDiffFormatter();
2509 return $format->format( $diffs );
2512 # Make temporary files
2514 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2515 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2517 fwrite( $oldtextFile, $before );
2518 fclose( $oldtextFile );
2519 fwrite( $newtextFile, $after );
2520 fclose( $newtextFile );
2522 // Get the diff of the two files
2523 $cmd = "$wgDiff " . $params . ' ' . Shell
::escape( $oldtextName, $newtextName );
2525 $h = popen( $cmd, 'r' );
2527 unlink( $oldtextName );
2528 unlink( $newtextName );
2529 throw new Exception( __METHOD__
. '(): popen() failed' );
2535 $data = fread( $h, 8192 );
2536 if ( strlen( $data ) == 0 ) {
2544 unlink( $oldtextName );
2545 unlink( $newtextName );
2547 // Kill the --- and +++ lines. They're not useful.
2548 $diff_lines = explode( "\n", $diff );
2549 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2550 unset( $diff_lines[0] );
2552 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2553 unset( $diff_lines[1] );
2556 $diff = implode( "\n", $diff_lines );
2562 * This function works like "use VERSION" in Perl, the program will die with a
2563 * backtrace if the current version of PHP is less than the version provided
2565 * This is useful for extensions which due to their nature are not kept in sync
2566 * with releases, and might depend on other versions of PHP than the main code
2568 * Note: PHP might die due to parsing errors in some cases before it ever
2569 * manages to call this function, such is life
2571 * @see perldoc -f use
2573 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2575 * @deprecated since 1.30
2577 * @throws MWException
2579 function wfUsePHP( $req_ver ) {
2580 $php_ver = PHP_VERSION
;
2582 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2583 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2588 * This function works like "use VERSION" in Perl except it checks the version
2589 * of MediaWiki, the program will die with a backtrace if the current version
2590 * of MediaWiki is less than the version provided.
2592 * This is useful for extensions which due to their nature are not kept in sync
2595 * Note: Due to the behavior of PHP's version_compare() which is used in this
2596 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2597 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2598 * targeted version number. For example if you wanted to allow any variation
2599 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2600 * not result in the same comparison due to the internal logic of
2601 * version_compare().
2603 * @see perldoc -f use
2605 * @deprecated since 1.26, use the "requires" property of extension.json
2606 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2607 * @throws MWException
2609 function wfUseMW( $req_ver ) {
2612 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2613 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2618 * Return the final portion of a pathname.
2619 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2620 * https://bugs.php.net/bug.php?id=33898
2622 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2623 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2625 * @param string $path
2626 * @param string $suffix String to remove if present
2629 function wfBaseName( $path, $suffix = '' ) {
2630 if ( $suffix == '' ) {
2633 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2637 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2645 * Generate a relative path name to the given file.
2646 * May explode on non-matching case-insensitive paths,
2647 * funky symlinks, etc.
2649 * @param string $path Absolute destination path including target filename
2650 * @param string $from Absolute source path, directory only
2653 function wfRelativePath( $path, $from ) {
2654 // Normalize mixed input on Windows...
2655 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2656 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2658 // Trim trailing slashes -- fix for drive root
2659 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2660 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2662 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2663 $against = explode( DIRECTORY_SEPARATOR
, $from );
2665 if ( $pieces[0] !== $against[0] ) {
2666 // Non-matching Windows drive letters?
2667 // Return a full path.
2671 // Trim off common prefix
2672 while ( count( $pieces ) && count( $against )
2673 && $pieces[0] == $against[0] ) {
2674 array_shift( $pieces );
2675 array_shift( $against );
2678 // relative dots to bump us to the parent
2679 while ( count( $against ) ) {
2680 array_unshift( $pieces, '..' );
2681 array_shift( $against );
2684 array_push( $pieces, wfBaseName( $path ) );
2686 return implode( DIRECTORY_SEPARATOR
, $pieces );
2690 * Convert an arbitrarily-long digit string from one numeric base
2691 * to another, optionally zero-padding to a minimum column width.
2693 * Supports base 2 through 36; digit values 10-36 are represented
2694 * as lowercase letters a-z. Input is case-insensitive.
2696 * @deprecated since 1.27 Use Wikimedia\base_convert() directly
2698 * @param string $input Input number
2699 * @param int $sourceBase Base of the input number
2700 * @param int $destBase Desired base of the output
2701 * @param int $pad Minimum number of digits in the output (pad with zeroes)
2702 * @param bool $lowercase Whether to output in lowercase or uppercase
2703 * @param string $engine Either "gmp", "bcmath", or "php"
2704 * @return string|bool The output number as a string, or false on error
2706 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2707 $lowercase = true, $engine = 'auto'
2709 wfDeprecated( __FUNCTION__
, '1.27' );
2710 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2714 * Reset the session id
2716 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2719 function wfResetSessionID() {
2720 wfDeprecated( __FUNCTION__
, '1.27' );
2721 $session = SessionManager
::getGlobalSession();
2722 $delay = $session->delaySave();
2724 $session->resetId();
2726 // Make sure a session is started, since that's what the old
2727 // wfResetSessionID() did.
2728 if ( session_id() !== $session->getId() ) {
2729 wfSetupSession( $session->getId() );
2732 ScopedCallback
::consume( $delay );
2736 * Initialise php session
2738 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2739 * Generally, "using" SessionManager will be calling ->getSessionById() or
2740 * ::getGlobalSession() (depending on whether you were passing $sessionId
2741 * here), then calling $session->persist().
2742 * @param bool|string $sessionId
2744 function wfSetupSession( $sessionId = false ) {
2745 wfDeprecated( __FUNCTION__
, '1.27' );
2748 session_id( $sessionId );
2751 $session = SessionManager
::getGlobalSession();
2752 $session->persist();
2754 if ( session_id() !== $session->getId() ) {
2755 session_id( $session->getId() );
2757 MediaWiki\
quietCall( 'session_start' );
2761 * Get an object from the precompiled serialized directory
2763 * @param string $name
2764 * @return mixed The variable on success, false on failure
2766 function wfGetPrecompiledData( $name ) {
2769 $file = "$IP/serialized/$name";
2770 if ( file_exists( $file ) ) {
2771 $blob = file_get_contents( $file );
2773 return unserialize( $blob );
2780 * Make a cache key for the local wiki.
2782 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2783 * @param string $args,...
2786 function wfMemcKey( /*...*/ ) {
2787 return call_user_func_array(
2788 [ ObjectCache
::getLocalClusterInstance(), 'makeKey' ],
2794 * Make a cache key for a foreign DB.
2796 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2799 * @param string $prefix
2800 * @param string $args,...
2803 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2804 $args = array_slice( func_get_args(), 2 );
2805 $keyspace = $prefix ?
"$db-$prefix" : $db;
2806 return call_user_func_array(
2807 [ ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ],
2808 [ $keyspace, $args ]
2813 * Make a cache key with database-agnostic prefix.
2815 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2816 * instead. Must have a prefix as otherwise keys that use a database name
2817 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2819 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2821 * @param string $args,...
2824 function wfGlobalCacheKey( /*...*/ ) {
2825 return call_user_func_array(
2826 [ ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ],
2832 * Get an ASCII string identifying this wiki
2833 * This is used as a prefix in memcached keys
2837 function wfWikiID() {
2838 global $wgDBprefix, $wgDBname;
2839 if ( $wgDBprefix ) {
2840 return "$wgDBname-$wgDBprefix";
2847 * Split a wiki ID into DB name and table prefix
2849 * @param string $wiki
2853 function wfSplitWikiID( $wiki ) {
2854 $bits = explode( '-', $wiki, 2 );
2855 if ( count( $bits ) < 2 ) {
2862 * Get a Database object.
2864 * @param int $db Index of the connection to get. May be DB_MASTER for the
2865 * master (for write queries), DB_REPLICA for potentially lagged read
2866 * queries, or an integer >= 0 for a particular server.
2868 * @param string|string[] $groups Query groups. An array of group names that this query
2869 * belongs to. May contain a single string if the query is only
2872 * @param string|bool $wiki The wiki ID, or false for the current wiki
2874 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2875 * will always return the same object, unless the underlying connection or load
2876 * balancer is manually destroyed.
2878 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2879 * updater to ensure that a proper database is being updated.
2881 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2882 * on an injected instance of LoadBalancer.
2884 * @return \Wikimedia\Rdbms\Database
2886 function wfGetDB( $db, $groups = [], $wiki = false ) {
2887 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
2891 * Get a load balancer object.
2893 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
2894 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
2896 * @param string|bool $wiki Wiki ID, or false for the current wiki
2897 * @return \Wikimedia\Rdbms\LoadBalancer
2899 function wfGetLB( $wiki = false ) {
2900 if ( $wiki === false ) {
2901 return MediaWikiServices
::getInstance()->getDBLoadBalancer();
2903 $factory = MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2904 return $factory->getMainLB( $wiki );
2909 * Get the load balancer factory object
2911 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
2913 * @return \Wikimedia\Rdbms\LBFactory
2915 function wfGetLBFactory() {
2916 return MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
2921 * Shortcut for RepoGroup::singleton()->findFile()
2923 * @param string|Title $title String or Title object
2924 * @param array $options Associative array of options (see RepoGroup::findFile)
2925 * @return File|bool File, or false if the file does not exist
2927 function wfFindFile( $title, $options = [] ) {
2928 return RepoGroup
::singleton()->findFile( $title, $options );
2932 * Get an object referring to a locally registered file.
2933 * Returns a valid placeholder object if the file does not exist.
2935 * @param Title|string $title
2936 * @return LocalFile|null A File, or null if passed an invalid Title
2938 function wfLocalFile( $title ) {
2939 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
2943 * Should low-performance queries be disabled?
2946 * @codeCoverageIgnore
2948 function wfQueriesMustScale() {
2949 global $wgMiserMode;
2951 ||
( SiteStats
::pages() > 100000
2952 && SiteStats
::edits() > 1000000
2953 && SiteStats
::users() > 10000 );
2957 * Get the path to a specified script file, respecting file
2958 * extensions; this is a wrapper around $wgScriptPath etc.
2959 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2961 * @param string $script Script filename, sans extension
2964 function wfScript( $script = 'index' ) {
2965 global $wgScriptPath, $wgScript, $wgLoadScript;
2966 if ( $script === 'index' ) {
2968 } elseif ( $script === 'load' ) {
2969 return $wgLoadScript;
2971 return "{$wgScriptPath}/{$script}.php";
2976 * Get the script URL.
2978 * @return string Script URL
2980 function wfGetScriptUrl() {
2981 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2982 /* as it was called, minus the query string.
2984 * Some sites use Apache rewrite rules to handle subdomains,
2985 * and have PHP set up in a weird way that causes PHP_SELF
2986 * to contain the rewritten URL instead of the one that the
2987 * outside world sees.
2989 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2990 * provides containing the "before" URL.
2992 return $_SERVER['SCRIPT_NAME'];
2994 return $_SERVER['URL'];
2999 * Convenience function converts boolean values into "true"
3000 * or "false" (string) values
3002 * @param bool $value
3005 function wfBoolToStr( $value ) {
3006 return $value ?
'true' : 'false';
3010 * Get a platform-independent path to the null file, e.g. /dev/null
3014 function wfGetNull() {
3015 return wfIsWindows() ?
'NUL' : '/dev/null';
3019 * Waits for the replica DBs to catch up to the master position
3021 * Use this when updating very large numbers of rows, as in maintenance scripts,
3022 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
3024 * By default this waits on the main DB cluster of the current wiki.
3025 * If $cluster is set to "*" it will wait on all DB clusters, including
3026 * external ones. If the lag being waiting on is caused by the code that
3027 * does this check, it makes since to use $ifWritesSince, particularly if
3028 * cluster is "*", to avoid excess overhead.
3030 * Never call this function after a big DB write that is still in a transaction.
3031 * This only makes sense after the possible lag inducing changes were committed.
3033 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3034 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3035 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3036 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3037 * @return bool Success (able to connect and no timeouts reached)
3038 * @deprecated since 1.27 Use LBFactory::waitForReplication
3040 function wfWaitForSlaves(
3041 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3043 if ( $timeout === null ) {
3044 $timeout = wfIsCLI() ?
86400 : 10;
3047 if ( $cluster === '*' ) {
3050 } elseif ( $wiki === false ) {
3055 wfGetLBFactory()->waitForReplication( [
3057 'cluster' => $cluster,
3058 'timeout' => $timeout,
3059 // B/C: first argument used to be "max seconds of lag"; ignore such values
3060 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
3062 } catch ( DBReplicationWaitError
$e ) {
3070 * Count down from $seconds to zero on the terminal, with a one-second pause
3071 * between showing each number. For use in command-line scripts.
3073 * @deprecated since 1.31, use Maintenance::countDown()
3075 * @codeCoverageIgnore
3076 * @param int $seconds
3078 function wfCountDown( $seconds ) {
3079 for ( $i = $seconds; $i >= 0; $i-- ) {
3080 if ( $i != $seconds ) {
3081 echo str_repeat( "\x08", strlen( $i +
1 ) );
3093 * Replace all invalid characters with '-'.
3094 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
3095 * By default, $wgIllegalFileChars includes ':', '/', '\'.
3097 * @param string $name Filename to process
3100 function wfStripIllegalFilenameChars( $name ) {
3101 global $wgIllegalFileChars;
3102 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3103 $name = preg_replace(
3104 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3108 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3109 $name = wfBaseName( $name );
3114 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3116 * @return int Resulting value of the memory limit.
3118 function wfMemoryLimit() {
3119 global $wgMemoryLimit;
3120 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3121 if ( $memlimit != -1 ) {
3122 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3123 if ( $conflimit == -1 ) {
3124 wfDebug( "Removing PHP's memory limit\n" );
3125 MediaWiki\
suppressWarnings();
3126 ini_set( 'memory_limit', $conflimit );
3127 MediaWiki\restoreWarnings
();
3129 } elseif ( $conflimit > $memlimit ) {
3130 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3131 MediaWiki\
suppressWarnings();
3132 ini_set( 'memory_limit', $conflimit );
3133 MediaWiki\restoreWarnings
();
3141 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3143 * @return int Prior time limit
3146 function wfTransactionalTimeLimit() {
3147 global $wgTransactionalTimeLimit;
3149 $timeLimit = ini_get( 'max_execution_time' );
3150 // Note that CLI scripts use 0
3151 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3152 set_time_limit( $wgTransactionalTimeLimit );
3155 ignore_user_abort( true ); // ignore client disconnects
3161 * Converts shorthand byte notation to integer form
3163 * @param string $string
3164 * @param int $default Returned if $string is empty
3167 function wfShorthandToInteger( $string = '', $default = -1 ) {
3168 $string = trim( $string );
3169 if ( $string === '' ) {
3172 $last = $string[strlen( $string ) - 1];
3173 $val = intval( $string );
3178 // break intentionally missing
3182 // break intentionally missing
3192 * Get the normalised IETF language tag
3193 * See unit test for examples.
3194 * See mediawiki.language.bcp47 for the JavaScript implementation.
3196 * @deprecated since 1.31, use LanguageCode::bcp47() directly.
3198 * @param string $code The language code.
3199 * @return string The language code which complying with BCP 47 standards.
3201 function wfBCP47( $code ) {
3202 return LanguageCode
::bcp47( $code );
3206 * Get a specific cache object.
3208 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3211 function wfGetCache( $cacheType ) {
3212 return ObjectCache
::getInstance( $cacheType );
3216 * Get the main cache object
3220 function wfGetMainCache() {
3221 global $wgMainCacheType;
3222 return ObjectCache
::getInstance( $wgMainCacheType );
3226 * Get the cache object used by the message cache
3230 function wfGetMessageCacheStorage() {
3231 global $wgMessageCacheType;
3232 return ObjectCache
::getInstance( $wgMessageCacheType );
3236 * Get the cache object used by the parser cache
3238 * @deprecated since 1.30, use MediaWikiServices::getParserCache()->getCacheStorage()
3241 function wfGetParserCacheStorage() {
3242 global $wgParserCacheType;
3243 return ObjectCache
::getInstance( $wgParserCacheType );
3247 * Call hook functions defined in $wgHooks
3249 * @param string $event Event name
3250 * @param array $args Parameters passed to hook functions
3251 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3253 * @return bool True if no handler aborted the hook
3254 * @deprecated since 1.25 - use Hooks::run
3256 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3257 wfDeprecated( __METHOD__
, '1.25' );
3258 return Hooks
::run( $event, $args, $deprecatedVersion );
3262 * Wrapper around php's unpack.
3264 * @param string $format The format string (See php's docs)
3265 * @param string $data A binary string of binary data
3266 * @param int|bool $length The minimum length of $data or false. This is to
3267 * prevent reading beyond the end of $data. false to disable the check.
3269 * Also be careful when using this function to read unsigned 32 bit integer
3270 * because php might make it negative.
3272 * @throws MWException If $data not long enough, or if unpack fails
3273 * @return array Associative array of the extracted data
3275 function wfUnpack( $format, $data, $length = false ) {
3276 if ( $length !== false ) {
3277 $realLen = strlen( $data );
3278 if ( $realLen < $length ) {
3279 throw new MWException( "Tried to use wfUnpack on a "
3280 . "string of length $realLen, but needed one "
3281 . "of at least length $length."
3286 MediaWiki\
suppressWarnings();
3287 $result = unpack( $format, $data );
3288 MediaWiki\restoreWarnings
();
3290 if ( $result === false ) {
3291 // If it cannot extract the packed data.
3292 throw new MWException( "unpack could not unpack binary data" );
3298 * Determine if an image exists on the 'bad image list'.
3300 * The format of MediaWiki:Bad_image_list is as follows:
3301 * * Only list items (lines starting with "*") are considered
3302 * * The first link on a line must be a link to a bad image
3303 * * Any subsequent links on the same line are considered to be exceptions,
3304 * i.e. articles where the image may occur inline.
3306 * @param string $name The image name to check
3307 * @param Title|bool $contextTitle The page on which the image occurs, if known
3308 * @param string $blacklist Wikitext of a file blacklist
3311 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3312 # Handle redirects; callers almost always hit wfFindFile() anyway,
3313 # so just use that method because it has a fast process cache.
3314 $file = wfFindFile( $name ); // get the final name
3315 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3317 # Run the extension hook
3319 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3323 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3324 $key = $cache->makeKey(
3325 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist )
3327 $badImages = $cache->get( $key );
3329 if ( $badImages === false ) { // cache miss
3330 if ( $blacklist === null ) {
3331 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3333 # Build the list now
3335 $lines = explode( "\n", $blacklist );
3336 foreach ( $lines as $line ) {
3338 if ( substr( $line, 0, 1 ) !== '*' ) {
3344 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3349 $imageDBkey = false;
3350 foreach ( $m[1] as $i => $titleText ) {
3351 $title = Title
::newFromText( $titleText );
3352 if ( !is_null( $title ) ) {
3354 $imageDBkey = $title->getDBkey();
3356 $exceptions[$title->getPrefixedDBkey()] = true;
3361 if ( $imageDBkey !== false ) {
3362 $badImages[$imageDBkey] = $exceptions;
3365 $cache->set( $key, $badImages, 60 );
3368 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3369 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3375 * Determine whether the client at a given source IP is likely to be able to
3376 * access the wiki via HTTPS.
3378 * @param string $ip The IPv4/6 address in the normal human-readable form
3381 function wfCanIPUseHTTPS( $ip ) {
3383 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3388 * Determine input string is represents as infinity
3390 * @param string $str The string to determine
3394 function wfIsInfinity( $str ) {
3395 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
3396 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3397 return in_array( $str, $infinityValues );
3401 * Returns true if these thumbnail parameters match one that MediaWiki
3402 * requests from file description pages and/or parser output.
3404 * $params is considered non-standard if they involve a non-standard
3405 * width or any non-default parameters aside from width and page number.
3406 * The number of possible files with standard parameters is far less than
3407 * that of all combinations; rate-limiting for them can thus be more generious.
3410 * @param array $params
3412 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3414 function wfThumbIsStandard( File
$file, array $params ) {
3415 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3417 $multipliers = [ 1 ];
3418 if ( $wgResponsiveImages ) {
3419 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3420 // @see Linker::processResponsiveImages
3421 $multipliers[] = 1.5;
3425 $handler = $file->getHandler();
3426 if ( !$handler ||
!isset( $params['width'] ) ) {
3431 if ( isset( $params['page'] ) ) {
3432 $basicParams['page'] = $params['page'];
3437 // Expand limits to account for multipliers
3438 foreach ( $multipliers as $multiplier ) {
3439 $thumbLimits = array_merge( $thumbLimits, array_map(
3440 function ( $width ) use ( $multiplier ) {
3441 return round( $width * $multiplier );
3444 $imageLimits = array_merge( $imageLimits, array_map(
3445 function ( $pair ) use ( $multiplier ) {
3447 round( $pair[0] * $multiplier ),
3448 round( $pair[1] * $multiplier ),
3454 // Check if the width matches one of $wgThumbLimits
3455 if ( in_array( $params['width'], $thumbLimits ) ) {
3456 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3457 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3458 $handler->normaliseParams( $file, $normalParams );
3460 // If not, then check if the width matchs one of $wgImageLimits
3462 foreach ( $imageLimits as $pair ) {
3463 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3464 // Decide whether the thumbnail should be scaled on width or height.
3465 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3466 $handler->normaliseParams( $file, $normalParams );
3467 // Check if this standard thumbnail size maps to the given width
3468 if ( $normalParams['width'] == $params['width'] ) {
3474 return false; // not standard for description pages
3478 // Check that the given values for non-page, non-width, params are just defaults
3479 foreach ( $params as $key => $value ) {
3480 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3489 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3491 * Values that exist in both values will be combined with += (all values of the array
3492 * of $newValues will be added to the values of the array of $baseArray, while values,
3493 * that exists in both, the value of $baseArray will be used).
3495 * @param array $baseArray The array where you want to add the values of $newValues to
3496 * @param array $newValues An array with new values
3497 * @return array The combined array
3500 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3501 // First merge items that are in both arrays
3502 foreach ( $baseArray as $name => &$groupVal ) {
3503 if ( isset( $newValues[$name] ) ) {
3504 $groupVal +
= $newValues[$name];
3507 // Now add items that didn't exist yet
3508 $baseArray +
= $newValues;
3514 * Get system resource usage of current request context.
3515 * Invokes the getrusage(2) system call, requesting RUSAGE_SELF if on PHP5
3516 * or RUSAGE_THREAD if on HHVM. Returns false if getrusage is not available.
3519 * @return array|bool Resource usage data or false if no data available.
3521 function wfGetRusage() {
3522 if ( !function_exists( 'getrusage' ) ) {
3524 } elseif ( defined( 'HHVM_VERSION' ) && PHP_OS
=== 'Linux' ) {
3525 return getrusage( 2 /* RUSAGE_THREAD */ );
3527 return getrusage( 0 /* RUSAGE_SELF */ );
3532 * Begin profiling of a function
3533 * @param string $functionname Name of the function we will profile
3534 * @deprecated since 1.25
3536 function wfProfileIn( $functionname ) {
3540 * Stop profiling of a function
3541 * @param string $functionname Name of the function we have profiled
3542 * @deprecated since 1.25
3544 function wfProfileOut( $functionname = 'missing' ) {